/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: avp_thread_worker.h
 *
 * Purpose: implementation a worker(wrapper thread)  for av player
 *
 * Developer:
 *   wen.gu , 2022-01-19
 *
 * TODO:
 *
 ***************************************************************************/

/******************************************************************************
 **    INCLUDES
 ******************************************************************************/
#ifndef __AVP_THREAD_WORKER_H__
#define __AVP_THREAD_WORKER_H__


#include "avp_type.h"
#include "avp_mutex.h"
/******************************************************************************
 **    MACROS
 ******************************************************************************/

/******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/
G_C_HEADER_START



struct _avp_thread_worker;
typedef struct _avp_thread_worker* avp_thread_worker_t;


/**
 * @brief a thread work function, will be not return until terminate the thread.
 * 
 * @param thd_worker [in] the worker instance, used for avp_thread_worker_running()
 * @param opaque [in] the user private data
 * @return void
 * @note the worker function will be like:
 *   void foo_worker(avp_thread_worker_t thd_worker, GPTR opaque)  
 *   {
 *         while(avp_thread_worker_running(thd_worker))
 *         {
 *               // todo something
 *         }
 *   }
 */
typedef void (*avp_thread_worker_func)(avp_thread_worker_t thd_worker, GPTR opaque);

/**
 * @brief a thread worker function, The 'loop' function returns every time it runs
 * 
 * @param opaque [in] the user private data
 * @return GS64: how long to wait.  > 0: will be wait a while, then run next loop , == 0: run next loop immediately, < 0: will be terninate this worker
 * @note the looper function will be like:
 *   GS64 fooo_looper(GPTR opaque)
 *   {
 *        // todo someting
 *        return 0; // if you want to terminate current worker, then can be: return -1
 *   }
 */
typedef GS64 (*avp_thread_loop_func)(GPTR opaque);

/******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/

/** if worker_name is NULL, then will not set worker to thread */
G_API GErrc avp_thread_worker_create(avp_thread_worker_t* thd_worker, const GSTR worker_name,  avp_thread_worker_func worker, GPTR opaque);
G_API GErrc avp_thread_worker_create2(avp_thread_worker_t* thd_worker, const GSTR worker_name, avp_thread_loop_func looper, GPTR opaque);

/** will be join(wait the terminate) and destroy the worker */
G_API void avp_thread_worker_join(avp_thread_worker_t thd_worker);

G_API GBOL avp_thread_worker_running(avp_thread_worker_t thd_worker);

G_API GErrc avp_thread_worker_start(avp_thread_worker_t thd_worker);
G_API GErrc avp_thread_worker_pause(avp_thread_worker_t thd_worker); 





G_C_HEADER_END

#endif /** !__AVP_THREAD_WORKER_H__ */

